fix(ci): remove redundant git-cliff output config to fix publish-release#619
Merged
Conversation
olivermeyer
requested review from
a team and
helmut-hoffer-von-ankershoffen
as code owners
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes the release automation configuration by removing a redundant git-cliff changelog output setting from pyproject.toml. In the SDK’s release process, publish-release.yml already decides whether changelog content is prepended to or written into CHANGELOG.md, so removing the config-level default avoids the conflicting -o/-p combination that was breaking release publication.
Changes:
- Remove
output = "CHANGELOG.md"from[tool.git-cliff.changelog]. - Leave changelog file selection to the release workflows, which already pass
--prependor--outputexplicitly.
neelay-aign
approved these changes
May 4, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The
publish-releaseworkflow was failing withgit-clifferror:'-o' and '-p' can only be used together if they point to different files. The[tool.git-cliff.changelog]section inpyproject.tomlsetsoutput = "CHANGELOG.md"(implicitly passing-o), while the workflow passes--prepend CHANGELOG.md(-p) explicitly — both pointing to the same file, which git-cliff now rejects.How?
Removed the
output = "CHANGELOG.md"line from[tool.git-cliff.changelog]inpyproject.toml. The workflow already controls the output path explicitly via--prependand--outputflags in each branch of the conditional, so the config-level default is redundant.